Db/gen remaining data structs #373

davidbloss · 2024-02-15T22:18:30Z

Issues

Changelog

Update gen.go to generate all of the data structs
Add interfaces.go - these are GraphQL "interfaces" like Check
Add object.go - these are GraphQL "objects", the majority of data structs

There are a lot of new structs being added that likely won't do anything for a while.
Some generated structs are replacing existing structs.

Some of these are identical
Some are the same with extra fields
LOADS of testing updates, mostly GraphQL query updates
There are 4 structs that don't have the ,omitempty json tag (can be added) but wanted to vet those first

The 4 structs needing vetting are (all in object.go):

Level
FilterPredicate
ServiceDocument
Tool

It's a lot... 😁 Thank you ahead of time for review this! 🙏
I also need to add changie logs

List your changes here
Make a changie entry

Tophatting

task generate

davidbloss · 2024-02-16T20:41:27Z

.golangci.yml

@@ -0,0 +1,3 @@
+linters:


Temporarily added because go vet points out an issue with ServiceDocumentSource.
Right now it looks like:

# Embedded, both `IntegrationId` and `ServiceRepository` have a clashing `json:"id"` tag type ServiceDocumentSource struct { IntegrationId `graphql:"... on ApiDocIntegration"` ServiceRepository `graphql:"... on ServiceRepository"` }

but it should look like

type ServiceDocumentSource struct { IntegrationId IntegrationId `graphql:"... on ApiDocIntegration"` ServiceRepository ServiceRepository `graphql:"... on ServiceRepository"` }

rocktavious · 2024-02-16T20:49:42Z

infra_test.go

 	autopilot.Equals(t, "my-big-query", result.Name)
 }

 func TestGetInfra(t *testing.T) {
 	// Arrange
 	testRequest := autopilot.NewTestRequest(
-		`query InfrastructureResourceGet($all:Boolean!$input:IdentifierInput!){account{infrastructureResource(input: $input){id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)}}}`,
+		`query InfrastructureResourceGet($all:Boolean!$input:IdentifierInput!){account{infrastructureResource(input: $input){aliases,data,href,id,integration,lastSyncedAt,name,owner{... on Team{teamAlias:alias,id}},ownerLocked,providerData{accountName,externalUrl,providerName},providerResourceType,rawData,type}}}`,


This change is no good - the extra directive @include(if: $all) on things is needed because otherwise for a list infra query we'll be pulling back HUGE amounts of data

rocktavious · 2024-02-16T20:56:24Z

actions.go

@@ -100,7 +78,7 @@ func (client *Client) GetCustomAction(input string) (*CustomActionsExternalActio
 		"input": *NewIdentifier(input),
 	}
 	err := client.Query(&q, v, WithName("ExternalActionGet"))
-	if q.Account.Action.Id == "" {
+	if q.Account.Action.CustomActionsId.Id == "" {


This feels like a poor UX change. Anyway we can make it like how it used to be?

rocktavious · 2024-02-16T20:58:31Z

object.go

+	DedupId             string `graphql:"dedupId" json:"dedupId"`                         // The deduplication ID provided to prevent duplicate deploys.
+	DeployNumber        string `graphql:"deployNumber" json:"deployNumber"`               // An identifier to keep track of the version of the deploy.
+	DeployUrl           string `graphql:"deployUrl" json:"deployUrl"`                     // The url the where the deployment can be found.
+	DeployedAt          string `graphql:"deployedAt" json:"deployedAt"`                   // The time the deployment happened.


this should be an ISO8601DateTime

rocktavious · 2024-02-16T20:58:57Z

object.go

+	ProviderName        string `graphql:"providerName" json:"providerName"`               // The integration name of the deploy.
+	ProviderType        string `graphql:"providerType" json:"providerType"`               // The integration type used the deploy.
+	ProviderUrl         string `graphql:"providerUrl" json:"providerUrl"`                 // The url to the deploy integration.
+	Service             string `graphql:"service" json:"service"`                         // The service object the deploy is attached to.


this looks like its a service object so should be a ServiceId

taimoorgit · 2024-02-16T21:00:42Z

document.go

@@ -1,16 +1,15 @@
 package opslevel

+// NOTE: test first, then replace this struct with commented out one below


Is this going to be changed in this PR, or the next one?

rocktavious · 2024-02-16T21:00:51Z

object.go

+
+// HasDocumentationCheck represents .
+type HasDocumentationCheck struct {
+	Campaign        string       `graphql:"campaign" json:"campaign"`               // The campaign the check belongs to.


This is actually a Campaign object so it needs to be a CampaignId type

rocktavious · 2024-02-16T21:12:40Z

object.go

+// Language represents a language that can be assigned to a repository.
+type Language struct {
+	Name  string  `graphql:"name" json:"name"`   // The name of the language.
+	Usage float32 `graphql:"usage" json:"usage"` // The percentage of the code written in that language.


do we know if Ruby is float64 or float32? Honestly if it works float64 is better in golang because the standard math lib works with float64 and you have to bring in a specialized math32 external library to support math operations on float32 OR you have to convert / cast type all the time.

rocktavious · 2024-02-16T21:13:38Z

object.go

+	Notes                 string       `graphql:"notes" json:"notes"`                                 // Additional information about the check.
+	Owner                 CheckOwner   `graphql:"owner" json:"owner"`                                 // The owner of the check.
+	Type                  CheckType    `graphql:"type" json:"type"`                                   // The type of check.
+	UpdateFrequency       string       `graphql:"updateFrequency" json:"updateFrequency"`             // The minimum frequency of the updates.


another one that is a specialized type

rocktavious · 2024-02-16T21:13:57Z

object.go

+	Owner                 CheckOwner   `graphql:"owner" json:"owner"`                                 // The owner of the check.
+	Type                  CheckType    `graphql:"type" json:"type"`                                   // The type of check.
+	UpdateFrequency       string       `graphql:"updateFrequency" json:"updateFrequency"`             // The minimum frequency of the updates.
+	UpdateRequiresComment string       `graphql:"updateRequiresComment" json:"updateRequiresComment"` // Whether the check requires a comment or not.


this is suppose to be a boolean 🤔

rocktavious · 2024-02-16T21:16:53Z

object.go

+// NewRelicIntegration represents .
+type NewRelicIntegration struct {
+	AccountKey                  string       `graphql:"accountKey" json:"accountKey"`                                   // The New Relic Account key for this integration.
+	AllowManualSyncAlertSources string       `graphql:"allowManualSyncAlertSources" json:"allowManualSyncAlertSources"` // Indicates if manual alert source synchronization can be triggered.


this one should also be a bool - this makes me a little scared about the generator is really not doing the right thing. Can we figure out why?

rocktavious · 2024-02-16T21:17:22Z

object.go

+	CreatedAt                   iso8601.Time `graphql:"createdAt" json:"createdAt"`                                     // The time this integration was created.
+	Id                          ID           `graphql:"id" json:"id"`                                                   // The unique identifier for the integration.
+	InstalledAt                 iso8601.Time `graphql:"installedAt" json:"installedAt"`                                 // The time that this integration was successfully installed, if null, this indicates the integration was not completed installed.
+	LastManualSyncAlertSources  string       `graphql:"lastManualSyncAlertSources" json:"lastManualSyncAlertSources"`   // The time that alert sources were last manually synchronized at.


another iso8601

davidbloss added 2 commits February 15, 2024 15:22

WIP: first big round of changes

ffb55e1

WIP: second round of changes, fixing tests

196f8f8

davidbloss requested review from rocktavious and taimoorgit February 15, 2024 22:18

davidbloss added 5 commits February 15, 2024 20:32

WIP: fixed tests and tpl files, almost done

6bdb27c

WIP: update properties and related tests

7410cd5

WIP: generate GraphQL union types

afb5c0f

fix test

a7c92d1

tmp ignore go vet, remove commented out code

b0cf334

davidbloss changed the title ~~WIP: Db/gen remaining data structs~~ Db/gen remaining data structs Feb 16, 2024

davidbloss marked this pull request as ready for review February 16, 2024 20:30

comment out some code gen parts until next PR

ede7141

davidbloss commented Feb 16, 2024

View reviewed changes

rocktavious reviewed Feb 16, 2024

View reviewed changes

taimoorgit reviewed Feb 16, 2024

View reviewed changes

rocktavious reviewed Feb 16, 2024

View reviewed changes

undo ID, aliases nesting in CustomActionsExternalAction

d77fe9e

rocktavious reviewed Feb 16, 2024

View reviewed changes

davidbloss added 4 commits February 22, 2024 10:02

use gqlgen to generated objects specifically

5644d77

reenable go generate in taskfile

584fd85

update gqlgen codegen

8d37168

committing to gqlgen, this is the way

1b00568

davidbloss marked this pull request as draft October 11, 2024 19:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Db/gen remaining data structs #373

Db/gen remaining data structs #373

davidbloss commented Feb 15, 2024 •

edited

Loading

davidbloss Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

davidbloss Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

taimoorgit Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

rocktavious Feb 16, 2024

		@@ -1,16 +1,15 @@
		package opslevel

		// NOTE: test first, then replace this struct with commented out one below

Db/gen remaining data structs #373

Are you sure you want to change the base?

Db/gen remaining data structs #373

Conversation

davidbloss commented Feb 15, 2024 • edited Loading

Issues

Changelog

Tophatting

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidbloss commented Feb 15, 2024 •

edited

Loading